home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / sm1d083.arc / SM1.DOC < prev    next >
Text File  |  1989-04-08  |  10KB  |  205 lines
  1. -------------------------------------------
  2. SM1 New User Registration DOOR version 0.83
  3. by DJ Chuang
  4. -------------------------------------------
  5.  
  6. SM1 is named for being the first door out of Southern Maryland.
  7.  
  8. This is a simple registration door for PCBoard 14.x sysops to
  9. assure that the users fills out a script questionnaire.  This is to
  10. allow the sysop control of what questions get answered by the user,
  11. and upon answering the questions, give them access to the BBS.  The
  12. user is displayed a number of sysop defined screens describing the
  13. rules of using the BBS, which will not be abortable by the user.
  14.  
  15. * SM1 features:
  16.  
  17.  o Custom script questionnaire, very similar to the main board's
  18.  o Force minimum chars response, if desired, on a per question basis
  19.  o User is upgraded to new security level upon questionnaire completion
  20.  o Optional visiting sysop questionnaire
  21.  o BBS rules text files are displayed to the users, who must agree to
  22.    the terms of each to complete their registration upgrade.  Unlike
  23.    the old "read bulletins then do the script questionnaire", the rules
  24.    text files are displayed to the user one screen at a time, but are
  25.    not abortable via the PCBoard/ProKit "more?" prompt.  
  26.  
  27. * Quick Installation:
  28.  
  29.  This is a Prokit door.  Simple to setup.
  30.  
  31.  You must have a configuration file to use this door.  The contents of
  32.  the configuration file are: (filename SM1.CNF) 
  33.  
  34.   INTERRUPT      <- ProKit parameter.  INTERRUPT, BIOS, or PCBTRAP
  35.   10             <- new user security level after completing questionnaire
  36.   50             <- new visiting sysop sec. level after sysop questionnaire
  37.   3              <- how many text files to show to user? (minimum: 1)
  38.   WELCOME        <- first screen to show, always shown, welcome scrn to door
  39.   RULES1         <- rules text filenames follow, one per line.  
  40.   RULES2
  41.  
  42.  And in your PCBoard system directory, the batch file to execute this
  43.  door should be something like:  (filename SM1)
  44.  
  45.   ECHO OFF
  46.   CD \PCB\SM1
  47.   SM1 SM1.CNF C:\PCB
  48.   CD \PCB
  49.   BOARD
  50.  
  51.  Then add the SM1 entry in your DOORS.DAT using PCBSETUP.  Setup a separate
  52.  BRDMx and BRDMxG main menu screen in your \PCB\GEN directory for your new 
  53.  users, so they will know which DOOR to open for registration and get 
  54.  registered using SM1.  You might even go so far as disabling all commands
  55.  on the main menu to the brand-new users who have a security level set in
  56.  the PCBSETUP new user level.  They get their menu, and know they have to
  57.  type DOOR 8 (or whatever).  Nothing else will happen for them, less 
  58.  confusing (maybe).
  59.  
  60.  
  61.  Then you have to generate some script questionnaires, which works in a
  62.  very similar fashion as the PCBoard script questionnaires; with one 
  63.  exception - and that is NO five-line header. (PCBoard questionnaires
  64.  require a five-line header before the questions list).  Extra options
  65.  are described in the technical portion of this document.  SCRIPT1 is
  66.  required in the SM1 working directory, and will be applied to all users
  67.  entering SM1 door.  SCRIPT2 is optional.  If it exists, it will be applied
  68.  to users who are visiting sysops.
  69.  
  70.  NOTE: In your PWRD file, for brand new users, give them the same download
  71.        bytes per day as you would if they have full access.  But disable
  72.        the download command for new users.  This is necessary because this
  73.        door only upgrades the user's security level and nothing else.
  74.        (what happens is if a brand new user signs on with 0 downloadable
  75.        bytes, after using SM1 door, he may have a new security level to do
  76.        more commands, but he will still have 0 bytes to download).
  77.        PCBoard doesn't expect users to have security level changes.
  78.        A future version may actually check your PWRD file, depending on 
  79.        response to this door.
  80.  
  81. * Technical information:
  82.  
  83.  - Graphics version of texts
  84.  
  85.  Text files may have ANSI graphics version, in the same manner that 
  86.  PCBoard bulletins and directories and menus can have graphics version.
  87.  If your first screen is WELCOME, then WELCOMEG will be the graphics
  88.  version.  The graphics version of any file are optional.  If it's there
  89.  in the working directory, it will be displayed to the user, otherwise
  90.  the regular text file will be displayed.
  91.  
  92.  - To display lots of rules text files
  93.  
  94.  The number in line 4 of your configuration determines how many rules
  95.  text files will be shown to the user.  The first one of this text files
  96.  list is meant to be a welcome screen.  The rest of them are rules, and
  97.  will be shown to the user one at a time, making sure they agree to each
  98.  text file of rules.  The screen will automatically pause every 23 lines,
  99.  but are not abortable. (it isn't a MORE prompt where the user could say
  100.  No and skip reading the important rules and disclaimers).
  101.  
  102.  - What happens to the new user
  103.  
  104.  The user will be greeted by the first screen in the configuration list
  105.  of text files.  This should be a welcome screen of sorts to let the user
  106.  know they're about to read the rules to the BBS and will answer some
  107.  questions after reading the rules.  After SM1 shows the user your
  108.  welcome screen, the user is asked if he wishes to register.  This is
  109.  just in case a user stumbles into this door when he already has full
  110.  board access. (no harm will come to those who decide to thru with the
  111.  questionnaires anyways).
  112.  
  113.  The next text files (which should be rules) will be displayed to the
  114.  user.  After each text file, the prompt "Do you agree with the above"
  115.  will be shown to the user, upon which they must type "Y" to affirm.
  116.  Otherwise, the door will dump the user back to the BBS without an upgrade.
  117.  
  118.  After the rules text files are displayed, the door will search the working
  119.  directory for filename SCRIPT1.  The format for this questionnaire is
  120.  just like PCBoard's script questionnaires, except there is NO five-line
  121.  header.  You may have multi-line questions displayed to the user by having
  122.  a ; (semicolon) in the first column.  Each line of the SCRIPT1 file is
  123.  a question (except for the comment lines, which are just displayed to the
  124.  user when a semicolon is in column 1).  And the user is to respond to the
  125.  question with up to a 70-character response.  A ruler bar marked off at
  126.  10-characters is shown with each question.
  127.  
  128.  The user will answer the questionnaire and the door will upgrade the
  129.  user's security level to what is in line 2 of the configuration file.
  130.  If the user has a security level greater than the upgrade security level,
  131.  nothing will be changed.  
  132.  
  133.  Then if SCRIPT2 exists in the working directory, the user is asked if 
  134.  he is a sysop.  If he answers affirmatively, then the second questionnaire
  135.  will applied to the user.  Upon completion, the user is granted the
  136.  security level in line 3 of the configuration file.  Line 3 may be
  137.  zero'd out if you don't have a 2nd script questionnaire for visiting sysops.
  138.  But line 3 may not be deleted (still needs to be there for a placeholder).
  139.  
  140.  All the user answers will be logged to a file named SM1.LOG .  The
  141.  question and answer session is topped with the user's name, city/state,
  142.  and phone numbers.  In addition, SM1SYSOP.LOG will log answers from just
  143.  the second (visiting sysops) questionnaire.  This is for those who wish 
  144.  to keep a log of sysop's who call your BBS.  Just delete SM1SYSOP.LOG
  145.  in your door batch file if you don't wish to keep this information.
  146.  
  147.  Both questionnaire answers are still logged entirely in SM1.LOG.  
  148.  
  149.  SM1 script questionnaires have one additional option.  If you wish to 
  150.  require a question to be responded with a minimum length response from
  151.  the user, prefix the question with a two-digit number plus a colon.
  152.  The door will re-prompt for a response when the user fails to leave a
  153.  response that is long enough.  For example:
  154.  
  155.  10:What is your City and State?
  156.  
  157.  This will require a minimum 10-char response from the user when given
  158.  this question.  The prefix is automatically stripped; the default minimum
  159.  response is 0.
  160.  
  161.  This door should work on networks. (I'm assuming using Prokit takes care
  162.  of all that file sharing stuff).
  163.  
  164.  
  165. Distribution
  166. ------------
  167.  Please freely distribute this package to other PCBoard's that might 
  168.  desire to have this style of new user registration.  No registration
  169.  fee is required from free access BBSes.  However, a donation is 
  170.  requested from subscription BBSes.  I suggest $25.
  171.  
  172.  Source is available for those who donate.  Be sure to contact me
  173.  if there's some customization you'd like to see for this door and
  174.  I'll tailor it for your BBS.
  175.  
  176.  DJ Chuang (BBS and address - valid thru August '89, when lease is up)
  177.  Extraordinaire
  178.  (301)737-0342
  179.  300/1200/2400 bauds
  180.  3005 Sayre Drive
  181.  Great Mills, MD  20634
  182.  
  183.  The author can also be reached at: (for you high-speeders)
  184.  
  185.  Southern Maryland Christian Info Service 
  186.  (301)862-3160
  187.  300/1200/2400/19200 USR HST
  188.  
  189.  
  190. SM1 Revision History
  191. --------------------
  192.  
  193. v 0.80 - Initial working release for SM1 registration door
  194. v 0.81 - Place all user answers in one text file called SM1.LOG
  195. v 0.82 - Fix a minor bug so when user presses return to the "agree?" prompt,
  196.          they will be forced to answer Y or N
  197. v 0.83 - OOPS!  Sorry.. rules screens were scrolling off without a query
  198.          to see if users agree.  0.82 didn't work as expected.
  199.          PLUS, now visiting sysop questionnaire answers are logged to 
  200.          a separate file named SM1SYSOP.LOG in addition to being logged
  201.          to SM1.LOG.  
  202.          And is now checking for dropped carrier and F8 to users during
  203.          questionnaire (it used to throw the door in an infinite loop -
  204.          not good).
  205.